Skip to content

Conversation

@Devon-White
Copy link
Contributor

@Devon-White Devon-White commented Nov 3, 2025

All Calling API commands have been separated into their own specs. This is so we can generate individual docs for each command. This helps the documentation become more readable.

We are unable to create the same path with the same request method more then one time in a single spec. This issues stems from the endpoint following OpenRPC patterns and we are using a Restful spec (OpenAPI.)

We also kept the original spec that combines all commands under a single endpoint utilizing anyOf. We must keep this if we ever want to allow users to generate SDK's from our specs. The OpenRPC specs are pulling the models (types) from the original spec definitions to prevent duplicate definitions.

This should allow us to update the models in one place, but get the best of both worlds

@netlify
Copy link

netlify bot commented Nov 3, 2025

Deploy Preview for signalwire-docs ready!

Name Link
🔨 Latest commit 3c0deed
🔍 Latest deploy log https://app.netlify.com/projects/signalwire-docs/deploys/6908adba0926940008edb572
😎 Deploy Preview https://deploy-preview-617--signalwire-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 25 (🟢 up 5 from production)
Accessibility: 91 (🔴 down 1 from production)
Best Practices: 92 (no change from production)
SEO: 89 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link

github-actions bot commented Nov 3, 2025

yarn run v1.22.22
$ /home/runner/work/docs/docs/node_modules/.bin/ts-node tools/scripts/generate-matrix.ts

OpenAPI Specification Analysis

Changes are compared to the main branch:

  • 🟢 Improvements (higher scores or fewer issues)
  • 🔴 Regressions (lower scores or more issues)
  • ⚪ No changes
Spec Docs Completeness SDK Gen Security Overall Warnings Errors Report
specs/compatibility-api/_spec_.yaml 72/100
(=) ⚪
69/100
(=) ⚪
79/100
(=) ⚪
39/100
(=) ⚪
65/100
(=) ⚪
468
(=) ⚪
368
(=) ⚪
View
specs/signalwire-rest/calling-api/open-rpc/dial/tsp-output/@typespec/openapi3/openapi.yaml 99/100 99/100 100/100 83/100 95/100 6 1 View
specs/signalwire-rest/calling-api/open-rpc/update/tsp-output/@typespec/openapi3/openapi.yaml 99/100 99/100 100/100 83/100 95/100 6 1 View
specs/signalwire-rest/calling-api/open-rpc/calling-end/tsp-output/@typespec/openapi3/openapi.yaml 99/100 99/100 100/100 83/100 95/100 6 1 View
specs/signalwire-rest/calling-api/open-rpc/calling-ai-hold/tsp-output/@typespec/openapi3/openapi.yaml 99/100 99/100 100/100 83/100 95/100 6 1 View
specs/signalwire-rest/calling-api/open-rpc/calling-ai-unhold/tsp-output/@typespec/openapi3/openapi.yaml 99/100 99/100 100/100 83/100 95/100 6 1 View
specs/signalwire-rest/calling-api/open-rpc/calling-ai-message/tsp-output/@typespec/openapi3/openapi.yaml 99/100 99/100 100/100 83/100 95/100 6 1 View
specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml 98/100
(=) ⚪
95/100
(=) ⚪
100/100
(=) ⚪
52/100
(=) ⚪
86/100
(=) ⚪
10
(=) ⚪
3
(=) ⚪
View
specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml 97/100
(=) ⚪
94/100
(=) ⚪
100/100
(=) ⚪
52/100
(=) ⚪
86/100
(=) ⚪
49
(=) ⚪
17
(=) ⚪
View
specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
557
(=) ⚪
2
(=) ⚪
View
specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
10
(=) ⚪
1
(=) ⚪
View
specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml 98/100
(=) ⚪
95/100
(=) ⚪
100/100
(=) ⚪
52/100
(=) ⚪
86/100
(=) ⚪
9
(=) ⚪
4
(=) ⚪
View
specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
10
(=) ⚪
1
(=) ⚪
View
specs/signalwire-rest/project-api/_spec_.yaml 76/100
(=) ⚪
73/100
(=) ⚪
69/100
(=) ⚪
36/100
(=) ⚪
64/100
(=) ⚪
21
(=) ⚪
14
(=) ⚪
View
specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
5
(=) ⚪
1
(=) ⚪
View
specs/signalwire-rest/space-api/_spec_.yaml 75/100
(=) ⚪
72/100
(=) ⚪
88/100
(=) ⚪
40/100
(=) ⚪
69/100
(=) ⚪
372
(=) ⚪
271
(=) ⚪
View
specs/signalwire-rest/video-api/_spec_.yaml 86/100
(=) ⚪
85/100
(=) ⚪
86/100
(=) ⚪
39/100
(=) ⚪
74/100
(=) ⚪
179
(=) ⚪
131
(=) ⚪
View
specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml 99/100
(=) ⚪
99/100
(=) ⚪
100/100
(=) ⚪
84/100
(=) ⚪
95/100
(=) ⚪
10
(=) ⚪
1
(=) ⚪
View

Done in 167.64s.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants